Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: replace enums in favour of pojos #72

Merged
merged 18 commits into from
Feb 24, 2024
Merged

Conversation

damienbutt
Copy link
Contributor

No description provided.

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Type: Refactoring

PR Summary: This pull request introduces a significant structural change by replacing enums with plain old JavaScript objects (POJOs) for defining constants related to signal types and reserved joins. It reorganizes the codebase to enhance modularity and readability. The changes include the addition of new files for analog, digital, and serial events and states, as well as the definition of signal types and reserved joins. Additionally, it modifies the main index file to export these new structures and types.

Decision: Comment

📝 Type: 'Refactoring' - not supported yet.
  • Sourcery currently only approves 'Typo fix' PRs.
✅ Issue addressed: this change correctly addresses the issue or implements the desired feature.
No details provided.
📝 Complexity: the changes are too large or complex for Sourcery to approve.
  • Unsupported files: the diff contains files that Sourcery does not currently support during reviews.
  • Files deleted: Sourcery does not currently approve diffs with deleted files.
  • Big diff: the diff is too large to approve with confidence.

General suggestions:

  • Ensure that the new structure of using POJOs over enums aligns with the project's coding standards and practices.
  • Review the naming conventions used for the newly introduced constants and types to ensure they are consistent and descriptive.
  • Consider the impact of these changes on other parts of the codebase that might rely on the previous enum-based approach, and ensure compatibility or necessary adjustments.

Thanks for using Sourcery. We offer it for free for open source projects and would be very grateful if you could help us grow. If you like it, would you consider sharing Sourcery on your favourite social media? ✨

Share Sourcery

Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

Removed:
- Csig.BlueLedBlinkBrightness
- Csig.GreenLedBlinkBrightness
- Csig.RedLedBlinkBrightness

Added:
+ Csig.BlueLedBrightness
+ Csig.Camera_Preset
+ Csig.Capture_color_mode
+ Csig.Conf_Mic_Vol
+ Csig.Conf_Spkr_Vol
+ Csig.Default_Spkr_Vol
+ Csig.Display_Orientation_Config
+ Csig.Docked_Standby_Timeout
+ Csig.GreenLedBrightness
+ Csig.Image_Mode
+ Csig.Polycom_TT_Enable_Analog_
+ Csig.Polycom_TT_Frame_Size_Analog_
+ Csig.Polycom_TT_Sensitivity_Analog
+ Csig.Power_Timeout
+ Csig.RedLedBrightness
+ Csig.TIMEZONE_INDEX
+ Csig.UCENGINE_auto_zoom_mode
+ Csig.UCENGINE_auto_zoom_speed
Removed:
- Csig.BlueLedBlinkBrightness_fb
- Csig.GreenLedBlinkBrightness_fb
- Csig.License_Days_Remaining_fb
- Csig.RedLedBlinkBrightness_fb
- Csig.RedLedBlinkBrightness_fb
- Csig.Trial_Period_Days_Remaining_fb

Added:
+ Csig.Battery_Level_fb
+ Csig.BlueLedBrightness_fb
+ Csig.Camera_Preset_fb
+ Csig.Capture_color_mode_fb
+ Csig.Conf_Mic_Vol_fb
+ Csig.Conf_Spkr_Vol_fb
+ Csig.Default_Spkr_Vol_fb
+ Csig.Display_Orientation_Config_fb
+ Csig.Docked_Standby_Timeout_fb
+ Csig.GreenLedBrightness_fb
+ Csig.Huddly_Room_Occupant_Count_fb
+ Csig.Image_Mode_fb
+ Csig.Polycom_TT_Enable_Analog__fb
+ Csig.Polycom_TT_Frame_Size_Analog__fb
+ Csig.Polycom_TT_Sensitivity_Analog_fb
+ Csig.Power_Timeout_fb
+ Csig.RedLedBrightness_fb
+ Csig.TIMEZONE_INDEX_fb
+ Csig.UCENGINE_auto_zoom_mode_fb
+ Csig.UCENGINE_auto_zoom_speed_fb
Added:
+ Csig.Admin_Account_Username
+ Csig.Occupancy_Sensor_IP_Address
Added:
+ Csig.Conf_Mic_Name_fb
+ Csig.Conf_Spkr_Name_fb
+ Csig.Default_Spkr_Name_fb
+ Csig.Huddly_Camera_Version_fb
+ Csig.Huddly_Serial_Number_fb
+ Csig.Huddly_Software_Version_fb
+ Csig.Huddly_Upgrade_Status_fb
+ Csig.Logitech_Sync_Version_fb
+ Csig.MTR_APP_state_fb
+ Csig.MTR_APP_version_state_fb
+ Csig.MTR_App_Version_fb
+ Csig.MTR_Camera_Status_fb
+ Csig.MTR_Conf_Mic_Status_fb
+ Csig.MTR_Conf_Spk_Status_fb
+ Csig.MTR_Content_Camera_Status_fb
+ Csig.MTR_Default_Spk_Status_fb
+ Csig.MTR_Hdmi_Ingest_Status_fb
+ Csig.MTR_Motion_Sensor_Status_fb
+ Csig.MTR_On_Front_Room_Display_Status_fb
+ Csig.Capture_hw_fw_fb
+ Csig.Capture_hw_name_fb
+ Csig.Occupancy_Sensor_IP_Address_fb
+ Csig.Product_Name_Text_Join_fb
+ Csig.Project_Date_fb
+ Csig.Project_Name_Text_Join_fb
+ Csig.Provisioning_version_fb
+ Csig.Software_build_fb
+ Csig.Soundbar_fw_version_fb
+ Csig.UCEngine_camera_fw_version_fb
+ Csig.UCEngine_camera_name_fb
+ Csig.Windows_build_fb
Copy link

github-actions bot commented Feb 24, 2024

size-limit report 📦

Path Size
0 B (-100% 🔽)
dist/index.cjs 4.08 KB (+100% 🔺)
dist/index.js 4.01 KB (+100% 🔺)

Removed:
- Csig.Browser_kiosk_off
- Csig.Browser_kiosk_on

Added:
+ Csig.Auto_Frame_OFF
+ Csig.Auto_Frame_ON
+ Csig.Browser_kiosk_off
+ Csig.Browser_kiosk_on
+ Csig.Camera_Down
+ Csig.Camera_Left
+ Csig.Camera_Preset_0
+ Csig.Camera_Preset_1
+ Csig.Camera_Preset_2
+ Csig.Camera_Preset_3
+ Csig.Camera_Preset_4
+ Csig.Camera_Right
+ Csig.Camera_Up
+ Csig.Camera_Zoom_In
+ Csig.Camera_Zoom_Out
+ Csig.Capture_Screenshot
+ Csig.Capture_color_mode_auto
+ Csig.Capture_color_mode_full
+ Csig.Capture_color_mode_limited
+ Csig.Conf_Mic_Vol_Down
+ Csig.Conf_Mic_Vol_Up
+ Csig.Conf_Spkr_Mute_Off
+ Csig.Conf_Spkr_Mute_On
+ Csig.Conf_Spkr_Mute_Toggle
+ Csig.Conf_Spkr_Vol_Down
+ Csig.Conf_Spkr_Vol_Up
+ Csig.Default_Spkr_Mute_Off
+ Csig.Default_Spkr_Mute_On
+ Csig.Default_Spkr_Mute_Toggle
+ Csig.Default_Spkr_Vol_Down
+ Csig.Default_Spkr_Vol_Up
+ Csig.Docked_Standby_Timeout_Dn
+ Csig.Docked_Standby_Timeout_Up
+ Csig.Hide_Project
+ Csig.Image_Mode_Teams
+ Csig.Image_Mode_Zoom
+ Csig.Jabra_AF_Intelligent
+ Csig.Jabra_AF_V_Director
+ Csig.Login
+ Csig.Logitech_fw_update_now
+ Csig.Logitech_rightsight_disabled
+ Csig.Logitech_rightsight_enabled
+ Csig.Logitech_rightsight_toggle
+ Csig.Logitech_sync_disabled
+ Csig.Logitech_sync_enabled
+ Csig.Logitech_sync_toggle
+ Csig.Movement_Wakes_LCD_Disabled
+ Csig.Movement_Wakes_LCD_Enabled
+ Csig.Mtr_Coordinated_Meetings
+ Csig.Occupancy_Sensor_Connected_
+ Csig.Occupancy_Sensor_Disconnected
+ Csig.Occupancy_Status_Occupied
+ Csig.Occupancy_Status_Vacant
+ Csig.Polycom_TT_Disabled
+ Csig.Polycom_TT_Enable_Group_Framing
+ Csig.Polycom_TT_Enable_Talker_Framing_
+ Csig.Polycom_TT_High_Sensitivity
+ Csig.Polycom_TT_Low_Sensitivity
+ Csig.Polycom_TT_Medium_Margin_
+ Csig.Polycom_TT_Medium_Sensitivity
+ Csig.Polycom_TT_Tight_Margin
+ Csig.Polycom_TT_Wide_Margin_
+ Csig.Power_Timeout_Dn
+ Csig.Power_Timeout_Up
+ Csig.Panel_Occupancy_Occupied
+ Csig.Panel_Occupancy_Vacant
+ Csig.Resume_from_Standby
+ Csig.Sensor_Occupancy_Occupied
+ Csig.Sensor_Occupancy_Vacant
+ Csig.Show_Project
+ Csig.Standby
+ Csig.UCENGINE_auto_zoom_speed_fast
+ Csig.UCENGINE_auto_zoom_speed_fastest
+ Csig.UCENGINE_auto_zoom_speed_medium
+ Csig.UCENGINE_auto_zoom_speed_slow
+ Csig.UCENGINE_auto_zoom_speed_slowest
+ Csig.Wallmount_Docking_Station_Force_Panel_Release
+ Csig.Windows_Update_Enable_ON
+ Csig.Zoom_nightly_reboot
Removed:
- Csig.Browser_kiosk_off_fb
- Csig.Browser_kiosk_on_fb
- Csig.Call_Active_fb
- Csig.Hard_Button_1.Press
- Csig.Hard_Button_2.Press
- Csig.Hard_Button_3.Press
- Csig.Hard_Button_4.Press
- Csig.Hard_Button_5.Press
- Csig.Lcd_Brt_Low_fb
- Csig.License_Invalid_fb
- Csig.License_Valid_fb
- Csig.Trial_Period_Off_fb
- Csig.Trial_Period_On_fb

Added:
+ Csig.Auto_Frame_OFF_fb
+ Csig.Auto_Frame_ON_fb
+ Csig.Browser_kiosk_off_fb
+ Csig.Browser_kiosk_on_fb
+ Csig.Camera_Preset_0_fb
+ Csig.Camera_Preset_1_fb
+ Csig.Camera_Preset_2_fb
+ Csig.Camera_Preset_3_fb
+ Csig.Camera_Preset_4_fb
+ Csig.Camera_connected_fb
+ Csig.Capture_color_mode_auto_fb
+ Csig.Capture_color_mode_full_fb
+ Csig.Capture_color_mode_limited_fb
+ Csig.CallActive_fb
+ Csig.Conf_Spkr_Mute_Off_fb
+ Csig.Conf_Spkr_Mute_On_fb
+ Csig.Conf_Spkr_Mute_Toggle_fb
+ Csig.Default_Spkr_Mute_Off_fb
+ Csig.Default_Spkr_Mute_On_fb
+ Csig.Default_Spkr_Mute_Toggle_fb
+ Csig.Dock_Power_Status_fb
+ Csig.Hide_Project_fb
+ Csig.Huddly_Camera_Connected_fb
+ Csig.Image_Mode_Teams_fb
+ Csig.Image_Mode_Zoom_fb
+ Csig.Jabra_AF_Intelligent_fb
+ Csig.Jabra_AF_V_Director_fb
+ Csig.Lcd_Brt_Lo_fb
+ Csig.Logitech_fw_update_now_fb
+ Csig.Logitech_rightsight_disabled_fb
+ Csig.Logitech_rightsight_enabled_fb
+ Csig.Logitech_rightsight_toggle_fb
+ Csig.Logitech_sync_disabled_fb
+ Csig.Logitech_sync_enabled_fb
+ Csig.Logitech_sync_toggle_fb
+ Csig.MTR_APP_Exchange_signed_in_fb
+ Csig.MTR_APP_Teams_signed_in_fb
+ Csig.MTR_APP_in_meeting_fb
+ Csig.MTR_App_Signed_in_fb
+ Csig.Movement_Wakes_LCD_Disabled_fb
+ Csig.Movement_Wakes_LCD_Enabled_fb
+ Csig.Mtr_Coordinated_Meetings_fb
+ Csig.Occupancy_Sensor_Connected__fb
+ Csig.Occupancy_Sensor_Disconnected_fb
+ Csig.Occupancy_Status_Occupied_fb
+ Csig.Occupancy_Status_Vacant_fb
+ Csig.Panel_Occupancy_Occupied_fb
+ Csig.Panel_Occupancy_Vacant_fb
+ Csig.Polycom_TT_Disabled_fb
+ Csig.Polycom_TT_Enable_Group_Framing_fb
+ Csig.Polycom_TT_Enable_Talker_Framing__fb
+ Csig.Polycom_TT_High_Sensitivity_fb
+ Csig.Polycom_TT_Low_Sensitivity_fb
+ Csig.Polycom_TT_Medium_Margin__fb
+ Csig.Polycom_TT_Medium_Sensitivity_fb
+ Csig.Polycom_TT_Tight_Margin_fb
+ Csig.Polycom_TT_Wide_Margin__fb
+ Csig.Resume_from_Standby_fb
+ Csig.Sensor_Occupancy_Occupied_fb
+ Csig.Sensor_Occupancy_Vacant_fb
+ Csig.Show_Project_fb
+ Csig.Standby_fb
+ Csig.System_Battery_Health_Indicator_fb
+ Csig.UCENGINE_auto_zoom_speed_fast_fb
+ Csig.UCENGINE_auto_zoom_speed_fastest_fb
+ Csig.UCENGINE_auto_zoom_speed_medium_fb
+ Csig.UCENGINE_auto_zoom_speed_slow_fb
+ Csig.UCENGINE_auto_zoom_speed_slowest_fb
+ Csig.Windows_Update_Enable_ON_fb
+ Csig.Zoom_nightly_reboot_fb
@damienbutt damienbutt merged commit 4af11d7 into develop Feb 24, 2024
16 checks passed
@damienbutt damienbutt deleted the feat/convert-enums branch February 24, 2024 21:12
Copy link

🎉 This PR is included in version 2.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant